GMs, your spellcasting players will love you for this script! With it, you can specify graphical areas of effect which your players can then spawn for their spells and other powers. All it takes is drawing a line to specify the effect's origin, range, and angle and selecting the effect from your list of saved AoEs.

You can get the script early from here (Also available from the One-Click installer), along with instructions on how to use it: https://github.com/Roll20/roll20-api-scripts/tree/master/AreasOfEffect

Demo:

Note: Currently it is not possible to create effects from graphics purchased from the market place due to certain restrictions specified here: https://wiki.roll20.net/API:Objects#imgsrc_and_avatar_property_restrictions

However, you can download them from your Roll20 purchased assets library and then upload them to your game in order to make use of them with this script.

Roadmap:

• import/export saved areas of effect.

Known issues:
https://app.roll20.net/forum/permalink/4404533/

Oh hot damn, very very nice!!

Where are those artworks from though out of curiousity?

I'll be taking this ;)

Very cool script.  Took a bit of figuring to get it working.  It requires the utility scripts (all available in the script library) of:  HTML Builder, MatrixMath, VectorMath, PathMath, and splitArgs.  Once those are in place it's pretty intuitive to use.

Kevin said:

Very cool script.  Took a bit of figuring to get it working.  It requires the utility scripts (all available in the script library) of:  HTML Builder, MatrixMath, VectorMath, PathMath, and splitArgs.  Once those are in place it's pretty intuitive to use.

Oh... right. Forgot the dependencies since those are so conveniently taken care of by OneClick. >_<

Saevar L. "Liquid-Sonic" said:

Where are those artworks from though out of curiousity?

The effects are my own artwork. The gnome is from one of the freebie packs. The map is from the Cybersmile promo pack.

Thank you for this Script. It is amazing.

I modified it to add the following functionnality:
I select a token, launch a macro, the macro ask which effect shall be displayed and ask to select the target.
It then displays the choosen effect coming from the selected token and going to the target.
This way i don't have to draw the line, it is done by the script. Then it uses your script to draw the special effect.

Laurent said:

Thank you for this Script. It is amazing.

I modified it to add the following functionnality:
I select a token, launch a macro, the macro ask which effect shall be displayed and ask to select the target.
It then displays the choosen effect coming from the selected token and going to the target.
This way i don't have to draw the line, it is done by the script. Then it uses your script to draw the special effect.

Awesome! Could you share how you modified it?

Dont suppose we could mix a script to drop templates for aoes that don't have a point of origin. Such as the famous fireball spell? Or should I just try to custom add that myself?

Saevar L. "Liquid-Sonic" said:

Dont suppose we could mix a script to drop templates for aoes that don't have a point of origin. Such as the famous fireball spell? Or should I just try to custom add that myself?

I would be very interested in such a script.  Something that could help "automate" generating and placing spell effects with a simple macro.  I love the ability to define specific effects, but in some cases the ability to simply "drop a 20' radius circle on that guy over there" would be a nice addition to the functionality of this script.

In my view having the ability to use the line to create a template is great and covers every type of case, so this is awesome.  But also having a menu of predefined settings to call from would be tremendous addition!

It would not be a problem for me to share my script, but as Stephen L. is the author of the unmodified script, i can't share it without his approbation. For AOE without point of origin i(ve modified the script to create an AOE after selecting a target and selecting a size (number of squares). But it doesn't help if you want to place your AOE in the middle of several targets, only if your effect is centered on one target.

Nice mods to the script there, Laurent! It's fine with me if you want to share it. Given the convenience of not having to do the additional step of drawing the lines, I might assimilate it into the main script for the next version. :)

The script can be found here :
https://dl.dropboxusercontent.com/u/91256389/Modif...

For the macros to use it (replace the part in Bold with your own effects):
To create an effect between two targets:
!spellfx @{selected|token_id} @{target|token_id} ?{Spell|Lightning,ligthningbolt|Cone of fire,firecone|Ray of fire,rayoffire|blue bolt,bluebolt|fire comets,firecomets|dragon flame,dragonflame|blue flame,blueflame|Flame blast,flameblast}

To create an effect on a selected token:
!aoespellfx @{selected|token_id} ?{Spell|Sun Burst,sunburst|Insects,insects} ?{Size|1}

Laurent said:

The script can be found here :
https://dl.dropboxusercontent.com/u/91256389/Modif...

For the macros to use it (replace the part in Bold with your own effects):
To create an effect between two targets:
!spellfx @{selected|token_id} @{target|token_id} ?{Spell|Lightning,ligthningbolt|Cone of fire,firecone|Ray of fire,rayoffire|blue bolt,bluebolt|fire comets,firecomets|dragon flame,dragonflame|blue flame,blueflame|Flame blast,flameblast}

To create an effect on a selected token:
!aoespellfx @{selected|token_id} ?{Spell|Sun Burst,sunburst|Insects,insects} ?{Size|1}

Just crashes for me :/

Can you post the error that you have in the api console ?

Just wanted to say thanks for this. We had a big battle saturday night that got a bit rough especially for the mage in our party. I implemented this today and showed him how to use it, and he is already a big fan. Thanks for making my game better!

Is this going to be in the script repository? If yes then any idea when it should hit?

There is an open pull request for putting this in the repository:  https://github.com/Roll20/roll20-api-scripts/pull/353

The pull is currently hung up on licensing details for the sample graphics I created for this script. Once the repository owners and I have settled that (hopefully soon), then you can expect to see it in there.

Outstanding- also is there a way for me to reference spell graphics I have purchased if I were to set up a table? 

Yes, but you would need to download them and then upload them into your library. Unfortunately, the Roll20 API doesn't allow spawned tokens to use image URLs directly from the marketplace because of this: https://wiki.roll20.net/API:Objects#imgsrc_and_avatar_property_restrictions

Alright, it looks like the script is now merged into the API repo. :)
Have fun, everybody!

This is an awesome script- thank you greatly Stephen. 

Sorry, there was an error in my script.
Here is the new version:
https://dl.dropboxusercontent.com/u/91256389/ModifiedAOS.js

Ive had an issue with it when trying to use it in my game (using from the API repo latest version).

Im getting this error:

"--- Initialized Areas Of Effect v1.0 ---"
{"who":"error","type":"error","content":"Unable to find a player or character with name: Pord (GM)"}

Looks like a case where the _fixwho() function isn't being applied, or is failing.

Pord said:

Ive had an issue with it when trying to use it in my game (using from the API repo latest version).

Im getting this error:

"--- Initialized Areas Of Effect v1.0 ---"
{"who":"error","type":"error","content":"Unable to find a player or character with name: Pord (GM)"}

Are you using just the core script, or are you using Laurent's mod?

Stephen- is there a way to transfer over the effects from game game to another? just a quality of life improvement for people with multiple campaigns. 

Stephen L. said:

Pord said:

Ive had an issue with it when trying to use it in my game (using from the API repo latest version).

Im getting this error:

"--- Initialized Areas Of Effect v1.0 ---"
{"who":"error","type":"error","content":"Unable to find a player or character with name: Pord (GM)"}

Are you using just the core script, or are you using Laurent's mod?

The one that's in the repo. It's the latest version selected on the API there. Not coded myself. It's on the drop down. 

Gary W. said:

Stephen- is there a way to transfer over the effects from game game to another? just a quality of life improvement for people with multiple campaigns. 

No, the effects are stored in the API state for your campaign, which is currently untransferable.

Pord said:

Stephen L. said:

Pord said:

Ive had an issue with it when trying to use it in my game (using from the API repo latest version).

Im getting this error:

"--- Initialized Areas Of Effect v1.0 ---"
{"who":"error","type":"error","content":"Unable to find a player or character with name: Pord (GM)"}

Are you using just the core script, or are you using Laurent's mod?

The one that's in the repo. It's the latest version selected on the API there. Not coded myself. It's on the drop down. 

Ok. I'll try to get that fixed soon. 

Did you incorporate Laurents quick action options?  They would be useful.

Stephen L. said:

Gary W. said:

Stephen- is there a way to transfer over the effects from game game to another? just a quality of life improvement for people with multiple campaigns. 

No, the effects are stored in the API state for your campaign, which is currently untransferable.

Pord said:

Stephen L. said:

Pord said:

Ive had an issue with it when trying to use it in my game (using from the API repo latest version).

Im getting this error:

"--- Initialized Areas Of Effect v1.0 ---"
{"who":"error","type":"error","content":"Unable to find a player or character with name: Pord (GM)"}

Are you using just the core script, or are you using Laurent's mod?

The one that's in the repo. It's the latest version selected on the API there. Not coded myself. It's on the drop down. 

Ok. I'll try to get that fixed soon. 

Found the issue.

There seems to be an issue with my name on the game.... if i use "Pord" or "Pord gm" its fine. However if I use "Pord (GM)" it gives the error... perhaps doesnt like the use of the brackets for name?

Oh!  You're actually typing the '(GM)' part?  That's generally added by Roll20 to names.  The _fixWho() function I mentioned strips that from the name before whispering it.  If you had typed that, it would wrongly strip it.  

In my own strips, I don't generally trust the msg.who and instead freshly pull the name from the playerid and so avoid both problems, but it doesn't account for when a character takes an action, so I can see that it would be preferable to keep in some situations.

Kevin Flynn said:

Did you incorporate Laurents quick action options?  They would be useful.

I'm planning on including Laurent's quick action options in the next version. I will make an announcement when that becomes available.

Update: v1.1 now available for beta

This update includes an arrow button for each effect, implementing Laurent's functionality for spawning an effect from one token to another.

Get it here: https://github.com/Cazra/roll20-api-scripts/tree/A...

The delete button doesn't seem to work?

Gary W. said:

The delete button doesn't seem to work?

Oops... Guess I broke something. I'll have it fixed in the next version.

I've got it fixed for v1.2.

You can grab it early from here: https://raw.githubusercontent.com/Cazra/roll20-api-scripts/AoE1.2/AreasOfEffect/1.2/aoe.js

Stephen, If I wanted to use the arrow version in a macro is there a way to skip chosing it from from the menu and just designate the effect and target?

Gary W. said:

Stephen, If I wanted to use the arrow version in a macro is there a way to skip chosing it from from the menu and just designate the effect and target?

You mean like a token macro?

This is an awesome script- really adds to the flavor of the table session. But it does take some time to access it. I don't think there is a way to avoid that extra time for the aoe centered on a point. The value of having the graphic on the screen makes that extra time worthwhile. On the single target spells spending that extra time isn't really worth the amount of wow factor.



BUT- if you could just add something like !areaofeffect --NameOfEffect that runs uses a @target command there wouldn't really be any extra work to use it.  And you get all the wow factor.

Gary W. said:

This is an awesome script- really adds to the flavor of the table session. But it does take some time to access it. I don't think there is a way to avoid that extra time for the aoe centered on a point. The value of having the graphic on the screen makes that extra time worthwhile. On the single target spells spending that extra time isn't really worth the amount of wow factor.



BUT- if you could just add something like !areaofeffect --NameOfEffect that runs uses a @target command there wouldn't really be any extra work to use it.  And you get all the wow factor.

Ah, I see. I'll see what can be done to reduce the time it takes to use the script. Thanks for the ideas.

Just something to note.  When you updated the script it apparently removed it from the auto install function of Roll20.  I was getting a "Could not load script, no scripts exist for this campaign." error until I copy/pasted your script as a new script (after deleting the old version).  Not sure why this happened, but I thought I'd let you know in case you know what happened.

Feadel Morauko said:

Just something to note.  When you updated the script it apparently removed it from the auto install function of Roll20.  I was getting a "Could not load script, no scripts exist for this campaign." error until I copy/pasted your script as a new script (after deleting the old version).  Not sure why this happened, but I thought I'd let you know in case you know what happened.

By auto-install, do you mean it no longer appears in One-Click?

i tried installing this script via one click and also via raw.  neither way allowed the script to start up without giving an error about save undefined.  anyone else seen this issue, or am i maybe missing a prereq?  i have all of these installed:  HTML Builder, Matrix Math, Path Math, Vector Math & splitArgs.  any help would be greatly appreciated.

here is the error in full:
TypeError: Cannot read property 'saved' of undefined TypeError: Cannot read property 'saved' of undefined at getEffectNamePrompt (apiscript.js:10079:44) at apiscript.js:10235:65 at Function._.each._.forEach (/home/node/d20-api-server/node_modules/underscore/underscore.js:153:9) at _updateShortcutMacros (apiscript.js:10229:7) at apiscript.js:10286:5 at eval (eval at (/home/node/d20-api-server/api.js:144:34), :65:16) at Object.publish (eval at (/home/node/d20-api-server/api.js:144:34), :70:8) at checkForReady (/home/node/d20-api-server/api.js:1205:12) at /home/node/d20-api-server/api.js:1284:9 at c (/home/node/d20-api-server/node_modules/firebase/lib/firebase-node.js:14:64)


i also have the following scripts installed: tokenmod, trackerjacker, 5th ed. ogl companion, pagefx, mark, chatsetattr, shell, groupinit.  i have tried deleting the scripts and readding them ( i believe i added splitargs after 1st installation so just troubleshooting ).  no love.... 

here is the api sandbox output:
Spinning up new sandbox...
"-=> TokenMod v0.8.23 <=- [Thu Nov 10 2016 19:21:57 GMT+0000 (UTC)]"
TypeError: Cannot read property 'saved' of undefined
TypeError: Cannot read property 'saved' of undefined
at getEffectNamePrompt (apiscript.js:10079:44)
at apiscript.js:10235:65
at Function._.each._.forEach (/home/node/d20-api-server/node_modules/underscore/underscore.js:153:9)
at _updateShortcutMacros (apiscript.js:10229:7)
at apiscript.js:10286:5
at eval (eval at <anonymous> (/home/node/d20-api-server/api.js:144:34), <anonymous>:65:16)
at Object.publish (eval at <anonymous> (/home/node/d20-api-server/api.js:144:34), <anonymous>:70:8)
at checkForReady (/home/node/d20-api-server/api.js:1205:12)
at /home/node/d20-api-server/api.js:1284:9
at c (/home/node/d20-api-server/node_modules/firebase/lib/firebase-node.js:14:64)

aaron h. said:
i tried installing this script via one click and also via raw.  neither way allowed the script to start up without giving an error about save undefined.  anyone else seen this issue, or am i maybe missing a prereq?  i have all of these installed:  HTML Builder, Matrix Math, Path Math, Vector Math & splitArgs.  any help would be greatly appreciated.

here is the error in full:
TypeError: Cannot read property 'saved' of undefined
TypeError: Cannot read property 'saved' of undefined
    at getEffectNamePrompt (apiscript.js:10079:44)
    at apiscript.js:10235:65
    at Function._.each._.forEach (/home/node/d20-api-server/node_modules/underscore/underscore.js:153:9)
    at _updateShortcutMacros (apiscript.js:10229:7)
    at apiscript.js:10286:5
    at eval (eval at  (/home/node/d20-api-server/api.js:144:34), :65:16)
    at Object.publish (eval at  (/home/node/d20-api-server/api.js:144:34), :70:8)
    at checkForReady (/home/node/d20-api-server/api.js:1205:12)
    at /home/node/d20-api-server/api.js:1284:9
    at c (/home/node/d20-api-server/node_modules/firebase/lib/firebase-node.js:14:64)


i also have the following scripts installed: tokenmod, trackerjacker, 5th ed. ogl companion, pagefx, mark, chatsetattr, shell, groupinit.  i have tried deleting the scripts and readding them ( i believe i added splitargs after 1st installation so just troubleshooting ).  no love.... 

here is the api sandbox output:
Spinning up new sandbox...
"-=> TokenMod v0.8.23 <=-  [Thu Nov 10 2016 19:21:57 GMT+0000 (UTC)]"
TypeError: Cannot read property 'saved' of undefined
TypeError: Cannot read property 'saved' of undefined
    at getEffectNamePrompt (apiscript.js:10079:44)
    at apiscript.js:10235:65
    at Function._.each._.forEach (/home/node/d20-api-server/node_modules/underscore/underscore.js:153:9)
    at _updateShortcutMacros (apiscript.js:10229:7)
    at apiscript.js:10286:5
    at eval (eval at <anonymous> (/home/node/d20-api-server/api.js:144:34), <anonymous>:65:16)
    at Object.publish (eval at <anonymous> (/home/node/d20-api-server/api.js:144:34), <anonymous>:70:8)
    at checkForReady (/home/node/d20-api-server/api.js:1205:12)
    at /home/node/d20-api-server/api.js:1284:9
    at c (/home/node/d20-api-server/node_modules/firebase/lib/firebase-node.js:14:64)

I wasn't getting this error with an upgraded copy of the script, but in a fresh new game, I was immediately able to reproduce your error. I'll look into fixing that soon.

For now follow the steps for this work-around:

1. Disable the AreasOfEffect script.
2. Create a script with the following contents:

_.defaults(state, {
  AreasOfEffect: {}
});
_.defaults(state.AreasOfEffect, {
  saved: {}
});

3. Re-enable the AreasOfEffect script.

thanks.  i will try that.  also, i loaded laurent's script from above ( stated 1.0 ) and it worked.  was getting ready to diff the scripts to see if i could find something.  i will do what you suggest and reply to here with result.

that additional script worked like a charm.  thanks for the quick reply.  now should be all set for my saturday game.  :)  

Stephen I didn't notice the update to the Area of Effect script- it is awesome. The burst effect is a huge time saver and lets you enjoy the look of the spell and gauge the area it covers without a ton of work. Thanks so much. 

You're welcome! :)

It seems that the burst operates a bit differently in scale? How do you recommend getting an accurately sized effect when setting up?